﻿/*
Copyright 2009 Matías Fidemraizer (www.matiasfidemraizer.com).

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

using System;
using System.Threading;
using System.Reflection;
using System.Resources;

#region "Custom namespace declarations"
using Comkarl;
using System.Globalization;
#endregion

namespace Comkarl.Architecture.Patterns
{
    /// <summary>
    /// Represents an exception thrown within the bounds of a pattern instance.
    /// </summary>
    /// <typeparam name="TIdentifierName">
    /// The type for the pattern identifier's exception.
    /// </typeparam>
    public abstract class PatternInstanceException<TIdentifierName> : ExceptionBase where TIdentifierName : IEquatable<TIdentifierName>
    {
        /// <summary>
        /// Default constructor.
        /// </summary>
        /// <param name="id">
        /// The identifier for the message which is going to be shown.
        /// </param>
        /// <param name="currentInstance">
        /// The pattern instance on which the exception has been thrown.
        /// </param>
        /// <param name="innerException">
        /// A generic exception that adds more information to the main one.
        /// </param>
        public PatternInstanceException(string id, PatternInstance<TIdentifierName> currentInstance, Exception innerException)
            : base(PatternInstanceException<TIdentifierName>.GetLocalizedStringByID(id), innerException)
        {
            this.currentInstance = currentInstance;
        }

        /// <summary>
        /// Retrieves the instance on which the exception has been thrown.
        /// </summary>
        private readonly PatternInstance<TIdentifierName> currentInstance;

        /// <summary>
        /// Gets the pattern instance on which the exception has been thrown.
        /// </summary>
        public PatternInstance<TIdentifierName> CurrentInstance
        {
            get
            {
                return currentInstance;
            }
        }

        /// <summary>
        /// Gets the localized string by its identifier.
        /// </summary>
        /// <param name="id">
        /// The identifier for the localized string.
        /// </param>
        /// <returns>
        /// The localized string.
        /// </returns>
        public static string GetLocalizedStringByID(string id)
        {
            return new ResourceManager("Comkarl.Architecture.Patterns.Globalization.Localization.PatternExceptionMessages", Assembly.GetExecutingAssembly()).GetString(id, CultureInfo.CurrentCulture);
        }
    }
}
